Map Rotation mod
================
By Mental Trousers http://www.planetstarsiege.com/mt/
mentaltrousers@planetstarsiege.com
18 Feb 2000

Contents
========
Blurb
Installation
Compatibility
How it works
Future changes
Map ratings
Altering the ratios
Disabling this mod
Exporting the list
Credits
Disclaimer 

Blurb
=====
This mod has been designed to provide a map rotation scheme that allows for automatic
swapping between the various different types of maps in base Tribes. It has a built in
rating system that allows you to bias the rotation however you like, as well as ensuring
that choosen maps are never in the automatic rotation.

This mod will work with either base Tribes, the admincon mod by Labrat, or the ixadmin
mod by *IX*Savage1 or the bwadmin mod by Poker. It has also been designed to use the new
maps that are part of the 1.10 upgrade to Tribes. These maps are also available
seperately from TribesPlayers.com for installation on 1.9 version servers. This mod uses
the server.cs file from v1.9 Tribes, and may be different to (and hence may not work on)
servers that run versions before 1.9

Installation
============
Please see the "!Tweak readme.txt" file for installation instructions.

Compatibility
=============
Please see the "!Tweak readme.txt" file for compatibilty information.

How it works
============
This mod first assembles 4 lists of maps that are based on the maps popularity. For
example, all of the verypopular maps make up one list, popular the next etc. Each of the
lists are circular ie the tail points back to the head.

When it comes time to change maps, the $MR::ratioString is examined a the next map with
the appropriate rating is used for the next mission. 

Future changes
==============
Might make it sensitive to the number of players on the server, eg if less than 4 people
play base ctf or a deathmatch map.

Map ratings
===========
You can change the rating of the maps by editing the mapRatings.cs file in this directory.
Simply find the name of the map that you wish to change the rating for and alter the
second field ie:

MR::setRating ("AntHill", "popular");
MR::setRating ("AntHill", "neverplay");

To enter a new map, just put in a new entry in the mapRatings.cs file and give it a
rating eg:

MR::setRating ("kickAssMap", "verypopular");

NOTE: If this mod finds map files that are not rated, it will automatically give them an
average rating. It will pick up all of the maps in the Tribes/base/missions directory and
put them into the map rotation scheme. Any experimental, or otherwise non-play maps
should be rated neverplay so that they are not used.

Altering the ratios
===================
The default ratios for this mod are verypopular 50%, popular 25%, average 16%, unpopular
9%. You can change these ratios to suit. In the mapRatings.cs file you will find this
string at the top of the file:

$MR::ratioString="1 2 1 3 1 1 3 2 4 1 1 2";

simply change it as required.

Disabling this mod
==================
At the top of the mapRotation.cs file, you will find the variable

$MR::enabled=true;

change it to false to return to the default Tribes map rotation. You must restart the
server before it will take effect.

Exporting the list
==================
You can export the list to see what maps are included in the rotation when running.
Change:

$MR::exportMapList=false;

to true. The file that is generated is Tribes/config/MRmaps.cs and will look something
like:

$MR::missionListAcrophobia = "TheLongWalk";
$MR::missionListADishBestServedCold = "Annihilator";
$MR::missionListAnnihilator = "Domino";

Credits
=======
The dev team
*IX*Savage1 - ixadmin - http://www.insomniax.net/
Labrat - admincon - http://labrat1.simplenet.com/sstribes/
Poker - bwadmin - poker@barrysworld.com
KB - he's the network dude at Clear Net and is the one responsible for the 3 Clear Net
     Tribes servers, and the one that asked me to write this mod www.novacula.com,
     www.clear.net.nz

Disclaimer
==========
I am not responsable for any damage this game modification may cause you or anything
having to do with you. If you lose your job because you play this game night and day,
it is purely your responsibility. I also am not responsable for any hardware failures
or software problems that may arise in TRIBES. For problems of that nature contact the
game manufacturer. If you believe this modification has problems please report them to
me so that I may look into it. - Mental Trousers 

(disclaimer borrowed from Labrat :)